<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/detail/util.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li><li class="navelem"><a class="el" href="dir_b5fa8338842f1288129dabc4bfd9a8d3.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">util.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="detail_2util__fwd_8hpp_source.html">ipc/util/detail/util_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="shared__name_8hpp_source.html">ipc/util/shared_name.hpp</a>&quot;</code><br />
<code>#include &lt;flow/error/error.hpp&gt;</code><br />
<code>#include &lt;flow/common.hpp&gt;</code><br />
<code>#include &lt;boost/interprocess/managed_shared_memory.hpp&gt;</code><br />
<code>#include &lt;boost/array.hpp&gt;</code><br />
</div>
<p><a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceipc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc.html">ipc</a></td></tr>
<tr class="memdesc:namespaceipc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow-IPC project: A library/API in modern C++17 providing high-performance communication between processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1util"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html">ipc::util</a></td></tr>
<tr class="memdesc:namespaceipc_1_1util"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-IPC modules and/or do not fit into any other Flow-IPC module. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5429c6225cc9a271ad8c0041d99c236b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">ipc::util::pipe_produce</a> (flow::log::Logger *logger_ptr, Pipe_writer *pipe)</td></tr>
<tr class="memdesc:a5429c6225cc9a271ad8c0041d99c236b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a byte to the given pipe writer.  <a href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">More...</a><br /></td></tr>
<tr class="separator:a5429c6225cc9a271ad8c0041d99c236b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a814272e555c0592b0caf92b7bc3d64b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">ipc::util::pipe_consume</a> (flow::log::Logger *logger_ptr, Pipe_reader *pipe)</td></tr>
<tr class="memdesc:a814272e555c0592b0caf92b7bc3d64b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a byte via the given pipe reader.  <a href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">More...</a><br /></td></tr>
<tr class="separator:a814272e555c0592b0caf92b7bc3d64b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cdc0a8d761170faa844c49d37c522ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">ipc::util::remove_persistent_shm_pool</a> (flow::log::Logger *logger_ptr, const Shared_name &amp;name, Error_code *err_code)</td></tr>
<tr class="memdesc:a1cdc0a8d761170faa844c49d37c522ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <a class="el" href="classipc_1_1shm_1_1classic_1_1Pool__arena.html#a9487dcff44fde9a2c12d64b51c16c85e" title="Removes the named SHM pool object.">shm::classic::Pool_arena::remove_persistent()</a>.  <a href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">More...</a><br /></td></tr>
<tr class="separator:a1cdc0a8d761170faa844c49d37c522ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a5716a13eb4de32e516ca257e025d8c20"><td class="memItemLeft" align="right" valign="top">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">ipc::util::SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a></td></tr>
<tr class="memdesc:a5716a13eb4de32e516ca257e025d8c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps general Permissions_level specifier to low-level <a class="el" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152" title="Short-hand for Unix (POSIX) permissions class.">Permissions</a> value, when the underlying resource is in the file-system and is either accessible (read-write in terms of file system) or inaccessible.  <a href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">More...</a><br /></td></tr>
<tr class="separator:a5716a13eb4de32e516ca257e025d8c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa74a8b46a5b38021c662a0b3bdfb46bf"><td class="memItemLeft" align="right" valign="top">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">ipc::util::PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a></td></tr>
<tr class="memdesc:aa74a8b46a5b38021c662a0b3bdfb46bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps general Permissions_level specifier to low-level <a class="el" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152" title="Short-hand for Unix (POSIX) permissions class.">Permissions</a> value, when the underlying resource is in the file-system (e.g., a file) and is <em>produced</em> (and therefore always writable) by the owning (creating, updating) user; but <em>consumed</em> (and therefore at most readable, never writable) by potentially other processes, and therefore possibly other users (e.g., group access or unrestricted access &ndash; but only for reading either way).  <a href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">More...</a><br /></td></tr>
<tr class="separator:aa74a8b46a5b38021c662a0b3bdfb46bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaa1fe31f8d77f78345dec8fc95e9882"><td class="memItemLeft" align="right" valign="top">const fs::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">ipc::util::IPC_KERNEL_PERSISTENT_RUN_DIR</a> = &quot;/var/run&quot;</td></tr>
<tr class="memdesc:aaaa1fe31f8d77f78345dec8fc95e9882"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute path to the directory (without trailing separator) in the file system where kernel-persistent runtime, but not temporary, information shall be placed.  <a href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">More...</a><br /></td></tr>
<tr class="separator:aaaa1fe31f8d77f78345dec8fc95e9882"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
